Update a Tariff
Use the following endpoint to edit or alter a tariff:
PUT 'apisandbox-billing-api.delfinance.com.br/billing-accounts/:billingAccountId'
Headers
Name | Description |
---|---|
x-delfinance-api-key | Required. API key |
Body attributes
Nome | Type | Description |
---|---|---|
bankAccount | string | Required. Bank account that will be charged |
fees | object | Object containing information about the fees |
fees.transactionTypeId | enum | Which type of transaction your customer will be charged - 7 - TED sent - 8 - TED received - 10 - Pix sent - 11 - Pix received - 12 - Refunded Pix received - 13 - Refunded Pix sent - 21 - TED refunded - 43 - Pix administrative refund - 78 - Refunded Pix sent (transaction undo) - 133 - Pix debited via MED RDR (transaction undo) - 9001 - Escrow monthly fee- 9002 - API monthly fee |
fees.price | number | Amount to be charged by fee |
fees.feeType | enum | Which type of transaction your customer will be charged - 7 - TED sent - 8 - TED received - 10 - Pix sent - 11 - Pix received - 12 - Refunded Pix received - 13 - Refunded Pix sent - 21 - TED refunded - 43 - Pix administrative refund - 78 - Refunded Pix sent (transaction undo) - 133 - Pix debited via MED RDR (transaction undo) - 9001 - Escrow monthly fee- 9002 - API monthly fee |
invoiceFrequency | object | The interval in which the customer will be charged - minute - Charge will activate every minute- hour - Charge will activate every hour- day - Charge will activate every day- week - Charge will activate every week- month - Charge will activate every month- year - Charge will activate every year |
invoiceFrequency.category | object | The interval in which the customer will be charged - minute - Charge will activate every minute- hour - Charge will activate every hour- day - Charge will activate every day- week - Charge will activate every week- month - Charge will activate every month- year - Charge will activate every year |
invoiceFrequency.amount | number | Amount that will be charged on defined interval |
startDate | date | The date when the fee calculation begins. |
nextInvoiceAt | date | The date where the first payment will occur, after this date the interval will set in |
Example
{
"invoiceDetails": [
{
"transactionTypeId": 10,
"price": 0.55
}
],
"frequency": {
"category": "month",
"amount": 1
},
"lastInvoicedAt": "2023-02-01",
"nextInvoicedAt": "2023-03-01"
}
Response
On a sucessful response you will receive a status code of 204